SourceLink
Description
The SourceLink property can simply be understood as text that represents a link between two e.g. two elements. It is similar to the String Property in the way it is stored.
Feature | Value |
---|---|
Theme injectable | - |
Possible Inputs | A-Z , a-z , 0-9 , Special characters |
SourceLink Elements
wrapper
Represents the type of wrapper the broadcaster is to be located in.
y-page
wrapper id
Basically the identification of the wrapper.
y-page:1
element
Stands for the element inside the wrapper and is therefore the broadcaster we want to receive something from.
y-page:1:y-table
element id
Basically the identification of the element.
y-page:1:y-table:3
event
Defines the specific event we want to listen to from our broadcaster element.
y-page:1:y-table:3:select-row
collection
Optional: Only applies for yTable or Clipboard! Defines the specific event data we want to receive, e.g. a certain data property of a Clipboard.
y-page:1:y-table:3:select-row:mypropertyone
Occurrences
Toolbar
In the Toolbar, you can conveniently set important SourceLinks directly using a Toolbar Extension with a SourceLink Picker . @Note insert image here
Detail Panel
You can find all source links of a component in the Detail Panel under the category "Links". Here, you will also use the SourceLink Picker to create a new SourceLink.
@Note insert image here
SourceLink Picker
Depending if you chose Name or ID mode the way the picker displays changes. The first case to be viewed shall be the case of ID.
- Toggle by Name or ID
This toggle decides whether you'll be identifying the target component by its Name or by its unique ID. Choose the method that best suits your needs for linking to a specific source. - Select Page
Here, you specify the page that contains the target component. This step is crucial for narrowing down the search scope and ensuring the link points to the correct page within your project. - Component Type
This option allows you to choose the type of component you wish to link to. By specifying the component type, you further refine the criteria for the link, making it easier to locate the exact component. - Component ID
After selecting the component type, you will need to specify the Component ID. This unique identifier ensures that the link targets the specific instance of the component you're referring to. - Event Response
Finally, select the event that will trigger the link. This setting determines how the link will be activated, allowing for customizable user interactions with the linked component. - Collection
If we receive an entire object as event data, we can determine here whether we want the entire object or just a specific value.
Alternatively when choosing Name the picker will look the following:
- Toggle by Name or ID
This toggle decides whether you'll be identifying the target component by its Name or by its unique ID. Choose the method that best suits your needs for linking to a specific source. - Select Page
Here, you specify the page that contains the target component. This step is crucial for narrowing down the search scope and ensuring the link points to the correct page within your project. - Name
Here you can enter the name of the Component, which should be unique and will be used to identify the component for the link. - Event Response
Finally, select the event that will trigger the link. This setting determines how the link will be activated, allowing for customizable user interactions with the linked component. - Collection
If we receive an entire object as event data, we can determine here whether we want the entire object or just a specific value.